/*
*  Copyright (c) 2001 Sun Microsystems, Inc.  All rights
*  reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*  1. Redistributions of source code must retain the above copyright
*  notice, this list of conditions and the following disclaimer.
*
*  2. Redistributions in binary form must reproduce the above copyright
*  notice, this list of conditions and the following disclaimer in
*  the documentation and/or other materials provided with the
*  distribution.
*
*  3. The end-user documentation included with the redistribution,
*  if any, must include the following acknowledgment:
*  "This product includes software developed by the
*  Sun Microsystems, Inc. for Project JXTA."
*  Alternately, this acknowledgment may appear in the software itself,
*  if and wherever such third-party acknowledgments normally appear.
*
*  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA"
*  must not be used to endorse or promote products derived from this
*  software without prior written permission. For written
*  permission, please contact Project JXTA at http://www.jxta.org.
*
*  5. Products derived from this software may not be called "JXTA",
*  nor may "JXTA" appear in their name, without prior written
*  permission of Sun.
*
*  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
*  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*  DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
*  ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
*  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
*  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
*  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
*  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*  SUCH DAMAGE.
*  ====================================================================
*
*  This software consists of voluntary contributions made by many
*  individuals on behalf of Project JXTA.  For more
*  information on Project JXTA, please see
*  <http://www.jxta.org/>.
*
*  This license is based on the BSD license adopted by the Apache Foundation.
*
*  $Id: SearchModifier.java,v 1.3 2005/01/12 08:48:58 gonzo Exp $
*/

package net.jxta.myjxta.search;

import net.jxta.myjxta.util.Resources;

import java.util.ResourceBundle;

/**
 *
 * @version $Id: SearchModifier.java,v 1.3 2005/01/12 08:48:58 gonzo Exp $
 *
 * @author james todd [gonzo at jxta dot org]
 */

public class SearchModifier {


    public static final String DEFAULT;
    public static final String EQUALITY;

    /** The character use as a wildcard character */
    public static final String WILDCARD = "*";

    /** A string used to compare to an empty string */
    private static final String EMPTY_STRING = "";
    private static final ResourceBundle STRINGS = Resources.getStrings();

    /** The label to describe this search */
    private String label = null;

    /** The prefix to put before the search term */
    private String prefix = null;

    /** The postfix to put after the search term */
    private String postfix = null;

    static {
        DEFAULT = STRINGS.getString("label.search.modifier.begins");
        EQUALITY = STRINGS.getString("label.search.modifier.equality");
    }

    /**
     * Create a new search modifer. The prefix and postfix are assumed to
     * be empty
     *
     * @param label the label to describe this search
     */
    public SearchModifier(String label) {
        this(label, EMPTY_STRING, EMPTY_STRING);
    }

    /**
     * Create a new search modifer. 
     *
     * @param label the  label to describe this search
     * @param prefix the prefix to use before the search term
     * @param postfix the postfix to use after the search term
     */
    public SearchModifier(String label, String prefix, String postfix) {
        this.label = label;
        this.prefix = prefix;
        this.postfix = postfix;
    }

    public String getLabel() {
        return this.label;
    }

    /**
     * Return the prefix to use before the search
     * 
     * @return the prefix to use before the search
     */
    public String getPrefix() {
        return this.prefix;
    }

    /**
     * Return the postfix to use after the search
     * 
     * @return the postfix to use after  the search
     */
    public String getPostfix() {
        return this.postfix;
    }

    /**
     * Create a new search term for the indicated search
     *
     * @param term the term to which to apply the wildcard
     *              in order to create the full search term
     */
    public String createTerm(String term) {
        return createTerm(term, WILDCARD);
    }

    /**
     * Create a new search term for the indicated search
     *
     * @param term the term to which to apply the wildcard
     *              in order to create the full search term
     * @param wildcard the wildcard string to use
     */
    public String createTerm(String term, String wildcard) {
        String s = term != null ? term.trim() : EMPTY_STRING;

        return (s.length() > 0 ?
                getPrefix() + s + getPostfix() : wildcard);
    }

    public boolean isEquality() {
        return EQUALITY.trim().equalsIgnoreCase(getLabel());
    }

    /**
     * Return the descriptive label for this search
     *
     * @return a descriptive label for this search
     */
    public String toString() {
        return this.label;
    }
}
